Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated structure for CD docs #242

Merged
merged 16 commits into from
Nov 13, 2023
Merged

Updated structure for CD docs #242

merged 16 commits into from
Nov 13, 2023

Conversation

swoodward90
Copy link
Contributor

Summary

Labels

Test Plan

Checklist

  • If required, I have updated the Plural documentation accordingly.
  • I have added tests to cover my changes.
  • I have added a meaningful title and summary to convey the impact of this PR to a user.
  • I have added relevant labels to this PR to help with categorization for release notes.

@swoodward90 swoodward90 requested a review from a team as a code owner November 6, 2023 19:41
@swoodward90 swoodward90 marked this pull request as draft November 6, 2023 19:41
Copy link

netlify bot commented Nov 6, 2023

Deploy Preview for pluraldocs ready!

Name Link
🔨 Latest commit 1590f25
🔍 Latest deploy log https://app.netlify.com/sites/pluraldocs/deploys/655298fc3852fa000855d440
😎 Deploy Preview https://deploy-preview-242--pluraldocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


## Log in to Console and Add Clusters

Once you've logged in to Plural Console, you can click the "Continuous deployment" tab to set up your clusters. By default, you should see the cluster that your Console is deployed on.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michaeljguarino just checking that this is true, they'll always at least have their current console cluster visible here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep


![](/assets/deployments/create-cluster.png)

To import an existing cluster, select the "Import existing" toggle and add a name, handle, and any tags. You then need to run the following command on the cluster itself to install the Plural Deploy Operator:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michaeljguarino any additional detail here on where to run this command? I can add this to the BYOK section too if helpful

To import an existing cluster, select the "Import existing" toggle and add a name, handle, and any tags. You then need to run the following command on the cluster itself to install the Plural Deploy Operator:

```
plural cd install --url https://<CONSOLE_URL>/ext/gql -- token <TOKEN>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michaeljguarino this is just the token from Console right? I can add instructions on how to get it or link to that helper page if so

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will also remove space in front of token

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the ui should tell them exactly what to run, yea


Global services are automatically replicated across existing and new clusters matching the set of defined specifications.

Once a service is deployed onto any cluster, it can be marked global by clicking the three dots in the deployments table and selecting "Make global".
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michaeljguarino what's the CLI command for this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure we have one yet

@swoodward90 swoodward90 marked this pull request as ready for review November 13, 2023 20:44
@michaeljguarino michaeljguarino merged commit 0b356af into main Nov 13, 2023
9 checks passed
@michaeljguarino michaeljguarino deleted the swoodward/cd-docs branch November 13, 2023 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants